Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bdocs: improvements + script for updating old links #8652

Merged
merged 30 commits into from
Dec 23, 2024

Conversation

internetisaiah
Copy link
Contributor

@internetisaiah internetisaiah commented Dec 18, 2024

Why are you making this change? (required)

Some general improvements to bdocs, as well as a new script that:

  1. Checks to see if old links listed in assets/js/broken_redirect_list.js are linked in any pages in _docs.
  2. If so, it replaces the old links found in _docs with the new link specified in the redirect file.

Related PRs, issues, or features (optional)

  • N/A

Feature release date (optional)

  • N/A

Contributor checklist

  • I confirm that my PR meets the following:
    • I signed the Contribution License Agreement (CLA).
    • My style and voice follows the Braze Style Guide.
    • My content contains correct spelling and grammar.
    • All links are working correctly.
    • If I renamed or moved a file or directory, I set up URL redirects for each file.
    • If I updated or replaced an image, I did not remove the original image file from the repository. (For more information, see Updating an image).
    • If my PR is related to a paid SKU, third party, SMS, AI, or privacy, I have received written approval from Braze Legal.

Submitting for review

If your PR meets the above requirements, select Ready for review, then add a reviewer:

  • Non-Braze contributors: Add braze-inc/docs-team as the reviewer.
  • Braze employees: Have any relevant subject matter experts (like engineers or product managers) review your work first, then add the tech writer assigned to your specific vertical. If you're not sure which tech writer to add, you can add braze-inc/docs-team instead.

Thanks for contributing! We look forward to reading your work.

@internetisaiah internetisaiah merged commit 1a5d314 into develop Dec 23, 2024
7 checks passed
@internetisaiah internetisaiah deleted the bdocs-update-links branch December 23, 2024 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants